package com.liukunup.demo.configuration;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2 配置信息
 * @author Liu Kun
 * @date 2021-03-22 00:02:31
 **/
@Configuration
@EnableSwagger2
public class Swagger2Configuration {

    /**
     * 指定扫描的包路径
     */
    private static final String PKG_PATH = "com.liukunup.demo.controller";

    /**
     * 当前版本
     */
    @Value("${app.version}")
    private String version;

    /**
     * 打包时间
     */
    @Value("${app.build.timestamp}")
    private String timestamp;

    /**
     * 创建该项目API应用
     * 通过 apiInfo() 增加API相关信息
     * 通过 select() 函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现
     * 采用指定扫描的包路径来定义指定要建立API的目录
     * @return Docket对象
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(PKG_PATH))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该项目API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return 接口基本信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("模板工程(DEMO) APIs")
                .description(String.format("构建时间: %s", timestamp))
                .termsOfServiceUrl("http://127.0.0.1:7001/swagger-ui.html")
                .version(version)
                .build();
    }
}
